home *** CD-ROM | disk | FTP | other *** search
/ Komputer for Alle 2004 #2 / K-CD-2-2004.ISO / OpenOffice Sv / f_0397 / python-core-2.2.2 / lib / cmd.py < prev    next >
Encoding:
Python Source  |  2003-07-18  |  11.5 KB  |  331 lines
  1. """A generic class to build line-oriented command interpreters.
  2.  
  3. Interpreters constructed with this class obey the following conventions:
  4.  
  5. 1. End of file on input is processed as the command 'EOF'.
  6. 2. A command is parsed out of each line by collecting the prefix composed
  7.    of characters in the identchars member.
  8. 3. A command `foo' is dispatched to a method 'do_foo()'; the do_ method
  9.    is passed a single argument consisting of the remainder of the line.
  10. 4. Typing an empty line repeats the last command.  (Actually, it calls the
  11.    method `emptyline', which may be overridden in a subclass.)
  12. 5. There is a predefined `help' method.  Given an argument `topic', it
  13.    calls the command `help_topic'.  With no arguments, it lists all topics
  14.    with defined help_ functions, broken into up to three topics; documented
  15.    commands, miscellaneous help topics, and undocumented commands.
  16. 6. The command '?' is a synonym for `help'.  The command '!' is a synonym
  17.    for `shell', if a do_shell method exists.
  18. 7. If completion is enabled, completing commands will be done automatically,
  19.    and completing of commands args is done by calling complete_foo() with
  20.    arguments text, line, begidx, endidx.  text is string we are matching
  21.    against, all returned matches must begin with it.  line is the current
  22.    input line (lstripped), begidx and endidx are the beginning and end
  23.    indexes of the text being matched, which could be used to provide
  24.    different completion depending upon which position the argument is in.
  25.  
  26. The `default' method may be overridden to intercept commands for which there
  27. is no do_ method.
  28.  
  29. The `completedefault' method may be overridden to intercept completions for
  30. commands that have no complete_ method.
  31.  
  32. The data member `self.ruler' sets the character used to draw separator lines
  33. in the help messages.  If empty, no ruler line is drawn.  It defaults to "=".
  34.  
  35. If the value of `self.intro' is nonempty when the cmdloop method is called,
  36. it is printed out on interpreter startup.  This value may be overridden
  37. via an optional argument to the cmdloop() method.
  38.  
  39. The data members `self.doc_header', `self.misc_header', and
  40. `self.undoc_header' set the headers used for the help function's
  41. listings of documented functions, miscellaneous topics, and undocumented
  42. functions respectively.
  43.  
  44. These interpreters use raw_input; thus, if the readline module is loaded,
  45. they automatically support Emacs-like command history and editing features.
  46. """
  47.  
  48. import string, sys
  49.  
  50. __all__ = ["Cmd"]
  51.  
  52. PROMPT = '(Cmd) '
  53. IDENTCHARS = string.ascii_letters + string.digits + '_'
  54.  
  55. class Cmd:
  56.     """A simple framework for writing line-oriented command interpreters.
  57.  
  58.     These are often useful for test harnesses, administrative tools, and
  59.     prototypes that will later be wrapped in a more sophisticated interface.
  60.  
  61.     A Cmd instance or subclass instance is a line-oriented interpreter
  62.     framework.  There is no good reason to instantiate Cmd itself; rather,
  63.     it's useful as a superclass of an interpreter class you define yourself
  64.     in order to inherit Cmd's methods and encapsulate action methods.
  65.  
  66.     """
  67.     prompt = PROMPT
  68.     identchars = IDENTCHARS
  69.     ruler = '='
  70.     lastcmd = ''
  71.     cmdqueue = []
  72.     intro = None
  73.     doc_leader = ""
  74.     doc_header = "Documented commands (type help <topic>):"
  75.     misc_header = "Miscellaneous help topics:"
  76.     undoc_header = "Undocumented commands:"
  77.     nohelp = "*** No help on %s"
  78.     use_rawinput = 1
  79.  
  80.     def __init__(self, completekey='tab'):
  81.         """Instantiate a line-oriented interpreter framework.
  82.  
  83.         The optional argument is the readline name of a completion key;
  84.         it defaults to the Tab key. If completekey is not None and the
  85.         readline module is available, command completion is done
  86.         automatically.
  87.  
  88.         """
  89.         if completekey:
  90.             try:
  91.                 import readline
  92.                 readline.set_completer(self.complete)
  93.                 readline.parse_and_bind(completekey+": complete")
  94.             except ImportError:
  95.                 pass
  96.  
  97.     def cmdloop(self, intro=None):
  98.         """Repeatedly issue a prompt, accept input, parse an initial prefix
  99.         off the received input, and dispatch to action methods, passing them
  100.         the remainder of the line as argument.
  101.  
  102.         """
  103.  
  104.         self.preloop()
  105.         if intro is not None:
  106.             self.intro = intro
  107.         if self.intro:
  108.             print self.intro
  109.         stop = None
  110.         while not stop:
  111.             if self.cmdqueue:
  112.                 line = self.cmdqueue[0]
  113.                 del self.cmdqueue[0]
  114.             else:
  115.                 if self.use_rawinput:
  116.                     try:
  117.                         line = raw_input(self.prompt)
  118.                     except EOFError:
  119.                         line = 'EOF'
  120.                 else:
  121.                     sys.stdout.write(self.prompt)
  122.                     sys.stdout.flush()
  123.                     line = sys.stdin.readline()
  124.                     if not len(line):
  125.                         line = 'EOF'
  126.                     else:
  127.                         line = line[:-1] # chop \n
  128.             line = self.precmd(line)
  129.             stop = self.onecmd(line)
  130.             stop = self.postcmd(stop, line)
  131.         self.postloop()
  132.  
  133.     def precmd(self, line):
  134.         """Hook method executed just before the command line is
  135.         interpreted, but after the input prompt is generated and issued.
  136.  
  137.         """
  138.         return line
  139.  
  140.     def postcmd(self, stop, line):
  141.         """Hook method executed just after a command dispatch is finished."""
  142.         return stop
  143.  
  144.     def preloop(self):
  145.         """Hook method executed once when the cmdloop() method is called."""
  146.         pass
  147.  
  148.     def postloop(self):
  149.         """Hook method executed once when the cmdloop() method is about to
  150.         return.
  151.  
  152.         """
  153.         pass
  154.  
  155.     def parseline(self, line):
  156.         line = line.strip()
  157.         if not line:
  158.             return None, None, line
  159.         elif line[0] == '?':
  160.             line = 'help ' + line[1:]
  161.         elif line[0] == '!':
  162.             if hasattr(self, 'do_shell'):
  163.                 line = 'shell ' + line[1:]
  164.             else:
  165.                 return None, None, line
  166.         i, n = 0, len(line)
  167.         while i < n and line[i] in self.identchars: i = i+1
  168.         cmd, arg = line[:i], line[i:].strip()
  169.         return cmd, arg, line
  170.  
  171.     def onecmd(self, line):
  172.         """Interpret the argument as though it had been typed in response
  173.         to the prompt.
  174.  
  175.         This may be overridden, but should not normally need to be;
  176.         see the precmd() and postcmd() methods for useful execution hooks.
  177.         The return value is a flag indicating whether interpretation of
  178.         commands by the interpreter should stop.
  179.  
  180.         """
  181.         cmd, arg, line = self.parseline(line)
  182.         if not line:
  183.             return self.emptyline()
  184.         if cmd is None:
  185.             return self.default(line)
  186.         self.lastcmd = line
  187.         if cmd == '':
  188.             return self.default(line)
  189.         else:
  190.             try:
  191.                 func = getattr(self, 'do_' + cmd)
  192.             except AttributeError:
  193.                 return self.default(line)
  194.             return func(arg)
  195.  
  196.     def emptyline(self):
  197.         """Called when an empty line is entered in response to the prompt.
  198.  
  199.         If this method is not overridden, it repeats the last nonempty
  200.         command entered.
  201.  
  202.         """
  203.         if self.lastcmd:
  204.             return self.onecmd(self.lastcmd)
  205.  
  206.     def default(self, line):
  207.         """Called on an input line when the command prefix is not recognized.
  208.  
  209.         If this method is not overridden, it prints an error message and
  210.         returns.
  211.  
  212.         """
  213.         print '*** Unknown syntax:', line
  214.  
  215.     def completedefault(self, *ignored):
  216.         """Method called to complete an input line when no command-specific
  217.         complete_*() method is available.
  218.  
  219.         By default, it returns an empty list.
  220.  
  221.         """
  222.         return []
  223.  
  224.     def completenames(self, text, *ignored):
  225.         dotext = 'do_'+text
  226.         return [a[3:] for a in self.get_names() if a.startswith(dotext)]
  227.  
  228.     def complete(self, text, state):
  229.         """Return the next possible completion for 'text'.
  230.  
  231.         If a command has not been entered, then complete against command list.
  232.         Otherwise try to call complete_<command> to get list of completions.
  233.         """
  234.         if state == 0:
  235.             import readline
  236.             origline = readline.get_line_buffer()
  237.             line = origline.lstrip()
  238.             stripped = len(origline) - len(line)
  239.             begidx = readline.get_begidx() - stripped
  240.             endidx = readline.get_endidx() - stripped
  241.             if begidx>0:
  242.                 cmd, args, foo = self.parseline(line)
  243.                 if cmd == '':
  244.                     compfunc = self.completedefault
  245.                 else:
  246.                     try:
  247.                         compfunc = getattr(self, 'complete_' + cmd)
  248.                     except AttributeError:
  249.                         compfunc = self.completedefault
  250.             else:
  251.                 compfunc = self.completenames
  252.             self.completion_matches = compfunc(text, line, begidx, endidx)
  253.         try:
  254.             return self.completion_matches[state]
  255.         except IndexError:
  256.             return None
  257.  
  258.     def get_names(self):
  259.         # Inheritance says we have to look in class and
  260.         # base classes; order is not important.
  261.         names = []
  262.         classes = [self.__class__]
  263.         while classes:
  264.             aclass = classes[0]
  265.             if aclass.__bases__:
  266.                 classes = classes + list(aclass.__bases__)
  267.             names = names + dir(aclass)
  268.             del classes[0]
  269.         return names
  270.  
  271.     def complete_help(self, *args):
  272.         return self.completenames(*args)
  273.  
  274.     def do_help(self, arg):
  275.         if arg:
  276.             # XXX check arg syntax
  277.             try:
  278.                 func = getattr(self, 'help_' + arg)
  279.             except:
  280.                 try:
  281.                     doc=getattr(self, 'do_' + arg).__doc__
  282.                     if doc:
  283.                         print doc
  284.                         return
  285.                 except:
  286.                     pass
  287.                 print self.nohelp % (arg,)
  288.                 return
  289.             func()
  290.         else:
  291.             names = self.get_names()
  292.             cmds_doc = []
  293.             cmds_undoc = []
  294.             help = {}
  295.             for name in names:
  296.                 if name[:5] == 'help_':
  297.                     help[name[5:]]=1
  298.             names.sort()
  299.             # There can be duplicates if routines overridden
  300.             prevname = ''
  301.             for name in names:
  302.                 if name[:3] == 'do_':
  303.                     if name == prevname:
  304.                         continue
  305.                     prevname = name
  306.                     cmd=name[3:]
  307.                     if help.has_key(cmd):
  308.                         cmds_doc.append(cmd)
  309.                         del help[cmd]
  310.                     elif getattr(self, name).__doc__:
  311.                         cmds_doc.append(cmd)
  312.                     else:
  313.                         cmds_undoc.append(cmd)
  314.             print self.doc_leader
  315.             self.print_topics(self.doc_header,   cmds_doc,   15,80)
  316.             self.print_topics(self.misc_header,  help.keys(),15,80)
  317.             self.print_topics(self.undoc_header, cmds_undoc, 15,80)
  318.  
  319.     def print_topics(self, header, cmds, cmdlen, maxcol):
  320.         if cmds:
  321.             print header
  322.             if self.ruler:
  323.                 print self.ruler * len(header)
  324.             (cmds_per_line,junk)=divmod(maxcol,cmdlen)
  325.             col=cmds_per_line
  326.             for cmd in cmds:
  327.                 if col==0: print
  328.                 print (("%-"+`cmdlen`+"s") % cmd),
  329.                 col = (col+1) % cmds_per_line
  330.             print "\n"
  331.